docs: align dev docs and release notes with current tooling#219
Conversation
local-development.md: reference the Makefile's fmt/vet/tidy targets and fix the build-all description (all six release platforms, not "all platforms"). RELEASE_NOTES.md: the file claimed the workflow replaces it with generated content, but nothing reads it — notes come from GitHub (goreleaser github-native), categorized by PR label via .github/release.yml. Rewrite to document that and keep the local --snapshot command.
|
Warning Review limit reached
Next review available in: 49 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughDocumentation updates align release-note generation, GoReleaser local builds, cross-compilation guidance, and local maintenance commands with the current GitHub and CI workflows. ChangesRelease and development documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@RELEASE_NOTES.md`:
- Around line 7-8: Update the “Other” release-notes description to describe
unmatched labels as the catch-all category, replacing the narrower “unlabeled”
wording while preserving the existing automated/bot exclusions and alignment
with labels: ['*'].
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 85286bfc-e942-4ea8-87cd-aafb1874728c
📒 Files selected for processing (2)
RELEASE_NOTES.mddocs/development/setup/local-development.md
The `['*']` category also catches labeled-but-uncategorized PRs, not only unlabeled ones. Fix the wording in RELEASE_NOTES.md and the .github/release.yml comment.
3 participants
local-development.md: reference the Makefile's fmt/vet/tidy targets and fix the build-all description (all six release platforms, not "all platforms").
RELEASE_NOTES.md: the file claimed the workflow replaces it with generated content, but nothing reads it — notes come from GitHub (goreleaser github-native), categorized by PR label via .github/release.yml. Rewrite to document that and keep the local --snapshot command.
Summary by CodeRabbit